/*
 * Copyright (c) 2007 Aleksey Nikiforov
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'Aleksey Nikiforov' nor the names of other contributors 
 *   may be used to endorse or promote products derived from this software 
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.lex.input.effects.interpolation;

import org.lex.input.effects.component.LoopedSpringModel;
import org.lex.input.effects.component.SpringModel;
import org.lex.input.effects.component.UnboundSpringModel;
import org.lex.input.effects.component.SpringConfig;


public class SpringInterpolation
	extends SpringConfig
	implements GoalInterpolation
{

	private SpringModel springModel;
	
	/**
	 * Constructs unbound spring interpolation.
	 * 
	 * @param mass
	 * @param springConstant
	 * @param dampingConstant
	 */
	public SpringInterpolation(float mass,
					  float springConstant,
					  float dampingConstant)
	{
		super(mass, springConstant, dampingConstant);
		springModel = new UnboundSpringModel(this);
		passOverAllowed = false;
	}
	
	/**
	 * Constructs looped spring interpolation in range [min, max].
	 * 
	 * @param mass
	 * @param springConstant
	 * @param dampingConstant
	 * @param min
	 * @param max
	 */
	public SpringInterpolation(float mass,
			  float springConstant,
			  float dampingConstant,
			  float min, float max)
	{
		super(mass, springConstant, dampingConstant);
		springModel = new LoopedSpringModel(this, min, max);
		passOverAllowed = false;
	}
	
	public void update(float deltaTime) {
		springModel.update(deltaTime);
	}
	
	public void clear() {
		springModel.stop();
	}

	public float getCurrent() {
		return springModel.getDisplacedPoint();
	}

	public void init(float current, float goal) {
		springModel.setDisplacedPoint(current);
		springModel.setRestPoint(goal);
		springModel.stop();
	}

	public void setGoal(float goal) {
		springModel.setRestPoint(goal);
	}

	public void setCurrent(float current) {
		springModel.setDisplacedPoint(current);
	}

	public boolean isAlive() {
		return (springModel.getDisplacement() != 0);
	}
	
}
